home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_qt.idb / usr / freeware / catman / p_man / cat3 / qdatasource.Z / qdatasource
Encoding:
Text File  |  1998-10-28  |  6.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))   QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee((((3333qqqqtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       QDataSource -    A QDataSource is an asynchronous producer of
  10.       data
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <qasyncio.h>
  14.  
  15.       Inherits QAsyncIO.
  16.  
  17.       Inherited by QIODeviceSource.
  18.  
  19.     PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
  20.       vvvviiiirrrrttttuuuuaaaallll iiiinnnntttt rrrreeeeaaaaddddyyyyTTTTooooSSSSeeeennnndddd (((())))
  21.       vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd sssseeeennnnddddTTTToooo ((((    QQQQDDDDaaaattttaaaaSSSSiiiinnnnkkkk ****,,,, iiiinnnntttt ccccoooouuuunnnntttt ))))
  22.       vvvvooooiiiidddd mmmmaaaayyyybbbbeeeeRRRReeeeaaaaddddyyyy (((())))
  23.       vvvviiiirrrrttttuuuuaaaallll bbbboooooooollll rrrreeeewwwwiiiinnnnddddaaaabbbblllleeee (((()))) ccccoooonnnnsssstttt
  24.       vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd eeeennnnaaaabbbblllleeeeRRRReeeewwwwiiiinnnndddd (((( bbbboooooooollll ))))
  25.       vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd rrrreeeewwwwiiiinnnndddd (((())))
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.       A QDataSource    is an asynchronous producer of data.
  29.  
  30.       A data source    is an object which provides data from some
  31.       source in an asynchronous manner. This means that at some
  32.       time not determined by the data source, blocks of data will
  33.       be taken from    it for processing. The data source is able to
  34.       limit    the maximum size of such blocks    which it is currently
  35.       able to provide.
  36.  
  37.       See also: QAsyncIO, QDataSink    and QDataPump.
  38.  
  39.      MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  40.      vvvvooooiiiidddd QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee::::::::eeeennnnaaaabbbblllleeeeRRRReeeewwwwiiiinnnndddd (((( bbbboooooooollll )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  41.       If this function is called with _o_n set to TRUE, and
  42.       rewindable() is TRUE,    then the data source must take
  43.       measures to allow the    rewind() function to subsequently
  44.       operate as described.    If rewindable()    is FALSE, the function
  45.       should call QDataSource::enableRewind(), which aborts    with a
  46.       fatal() error.
  47.  
  48.       For example, a network connection may    choose to utilize a
  49.       disk cache of    input only if rewinding    is enabled before the
  50.       first    buffer-full of data is discarded, returning FALSE in
  51.       rewindable() if that first buffer is discarded.
  52.  
  53.       Reimplemented    in QIODeviceSource.
  54.  
  55.      vvvvooooiiiidddd QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee::::::::mmmmaaaayyyybbbbeeeeRRRReeeeaaaaddddyyyy (((())))
  56.       This should be called    whenever readyToSend() might have
  57.       become non-zero. It is merely    calls QAsyncIO::ready()    if
  58.       readyToSend()    is non-zero.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 9/22/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))   QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee((((3333qqqqtttt))))
  71.  
  72.  
  73.  
  74.      iiiinnnntttt QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee::::::::rrrreeeeaaaaddddyyyyTTTTooooSSSSeeeennnndddd (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  75.       The data source should return    a value    indicating how much
  76.       data it is ready to provide. This may    be 0. If the data
  77.       source knows it will never be    able to    provide    any more data
  78.       (until after a rewind()), it may return -1.
  79.  
  80.       Reimplemented    in QIODeviceSource.
  81.  
  82.      vvvvooooiiiidddd QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee::::::::rrrreeeewwwwiiiinnnndddd (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  83.       This function    rewinds    the data source. This may only be
  84.       called if enableRewind(TRUE) has been    previously called.
  85.  
  86.      bbbboooooooollll QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee::::::::rrrreeeewwwwiiiinnnnddddaaaabbbblllleeee (((()))) ccccoooonnnnsssstttt [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  87.       This function    should return TRUE if the data source can be
  88.       rewound.
  89.  
  90.       The default returns FALSE.
  91.  
  92.       Reimplemented    in QIODeviceSource.
  93.  
  94.      vvvvooooiiiidddd QQQQDDDDaaaattttaaaaSSSSoooouuuurrrrcccceeee::::::::sssseeeennnnddddTTTToooo ((((    QQQQDDDDaaaattttaaaaSSSSiiiinnnnkkkk ****,,,, iiiinnnntttt ccccoooouuuunnnntttt )))) [[[[vvvviiiirrrrttttuuuuaaaallll]]]]
  95.       This function    is called to extract data from the source, by
  96.       sending it to    the given data sink. The count will be no more
  97.       than the amount indicated by the most    recent call to
  98.       readyToSend(). The source must use all the provided data,
  99.       and the sink will be prepared    to accept at least this    much
  100.       data.
  101.  
  102.       Reimplemented    in QIODeviceSource.
  103.  
  104.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  105.       hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqddddaaaattttaaaassssoooouuuurrrrcccceeee....hhhhttttmmmmllll
  106.  
  107.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  108.       Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
  109.       included in the distribution for a complete license
  110.       statement.
  111.  
  112.      AAAAUUUUTTTTHHHHOOOORRRR
  113.       Generated automatically from the source code.
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 9/22/98)
  130.  
  131.  
  132.  
  133.